-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Version 1 release #132
Version 1 release #132
Conversation
Co-authored-by: Adam Tyson <[email protected]>
Re-requesting review in light of the Zulip discussion. Meta-package docs are under |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One small request, but this is excellent, thanks @willGraham01. This is the type of project structure and documentation that we should have had all along! 🥳
docs/source/community/developers/repositories/brainglobe-meta/brainglobe-dependencies.svg
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great, Will - thank you!
A few minor nitpicky comments :)
docs/source/community/developers/repositories/brainglobe-meta/index.md
Outdated
Show resolved
Hide resolved
- `pip install brainglobe` is now the recommended way to install all BrainGlobe tools. | ||
- This will fetch the `brainglobe` meta-package, which includes the latest stable versions of all BrainGlobe tools and napari plugins. | ||
- All tools will be accessible in the install environment as if they had been pip-installed directly. | ||
- If you are updating to `brainglobe` version 1 having previously installed BrainGlobe tools individually, we [recommend you create](#updating-to-version-1) a clean Python environment and install `brainglobe` into this fresh environment to avoid potential package conflicts. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are at least parts of this a duplicate of what we already say on line 50 and should therefore be integrated there or here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Parts of it definitely are, but I felt duplicating these parts made more sense than only including them in one place or another. Otherwise it's not really a full changelog, and it's not worth a "see this section" when users only need to be redirected to one sentence?
Co-authored-by: Alessandro Felder <[email protected]>
See #33 |
pip install brainglobe
if you want to install the tools.workflows
is also now available.